スニペットの使用の検討

アプリケーションのヘルプを開発する場合、アプリケーションがまだ完成していないことがよくあります。

アプリケーションの開発と並行してヘルプを開発する必要があるので、これはヘルプ作成者にとって大きな問題です。ヘルプ作成者は、未完成な状態の画面をキャプチャする場合もあります。アプリケーションの完成が近づいたら、ヘルプ作成者は画面の画像を再キャプチャする必要があります。

この作業自体はそれほど難しくありませんが、画像を使用しているすべてのトピックで画像が最新のものに更新されていることを確認するのは手間がかかります。画像のサイズに変更がない場合は、古い画像と同じ場所に同じファイル名で新しい画像を保存するだけで済みます。

しかし、サイズが変更されている場合はどうでしょうか。

このような場合に、スニペットが役立ちます。各画像に対してスニペットを作成して、トピック内の通常は画像を挿入する場所にスニペットを挿入すると、多くの時間と労力を節約することができます。これは、1 か所で画像を変更することができるためです。1 か所で画像を変更すると、スニペットを使用するすべてのトピックで最新の画像が使用されることになります。画像をどのトピックで使用していたかを悩む必要がなくなります。

手順

処理

操作

1

スニペットポッドの表示

表示/ポッド/スニペットをクリックします。

2

新規スニペットの作成

ファイル/新規作成/スニペットをクリックします。

ドキュメント編集パッドに新しいスニペットが表示されます。

3

スニペットへの画像の挿入

ドキュメント編集パッドですべてのスニペットテキストを選択して、アプリケーションの画面キャプチャと置き換えます。

4

トピックへのスニペットの挿入

アプリケーションの画面キャプチャを表示する必要があるトピックを編集します。

スニペットをクリックして、スニペットポッドからトピックにドラッグします。

Screen_Level フォルダにある The_WidgetMax_Information_Screen.htm トピックを参照して、このテクニックの実装方法の例を確認してください。